Microsoft Marketplace Catalog Browse API (preview:2023-01-01)

2025/06/04 • 2 updated methods

SinglePublicProduct_Get (updated)
Description :  Get a single commercial Marketplace public product.
Reference :  Link ¶

⚶ Changes

{
  "#id": "SinglePublicProduct_Get",
  "Summary": {
    "new": "Get a single commercial Marketplace public product.",
    "old": "Single Public Product API provides an unauthenticated endpoint for consuming product attributes of a single commercial Marketplace public product. Each API request must include an API key allocated to you. Send an email to MKPL_Platform_API_DL@microsoft.com including the following details to get the API Key:\n- Customer name\n- Service/Product name\n- AD Registered App ID (if available)\n- Focal point email\n- Use case/scenario\n- Expected traffic volume, including peak requests per second (daily)"
  }
}

⚼ Request

GET:  /products/{id}
{
id:
{
Description: The unique product Id ,
Required: True ,
}
string ,
market:
{
Description: Product market value (the response will include only products that can be sold in the specified market) Possible values can be found at https://docs.microsoft.com/en-us/azure/marketplace/marketplace-geo-availability-currencies. Example: 'US' ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the REST API used for the request. ,
Required: True ,
}
string ,
language:
{
Description: Language to search, ISO 639-1 two-letter code, possible values - 'en,cs,de,es,fr,hu,it,ja,ko,nl,pl,pt-br,pt-pt,ru,sv,tr,zh-hans,zh-hant'. Default is "en" ,
Required: False ,
}
string ,
includeStopSoldPlans:
{
Description: Denotes whether to include stop sold plans ,
Required: False ,
}
boolean ,
hideKeys:
{
Description: Add hide key to retrieve preview items. Hidekeys are provided in 'multi' format. Example: HideKey[]=first ,
Required: False ,
}
array ,
X-API-Key:
{
Description: Use Api key provided by Marketplace Catalog Team as a parameter provided in the header ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
displayName:
{
Description: Product display name ,
Required: False ,
}
string ,
popularity:
{
Description: Popularity of the product ,
Format: double ,
Required: False ,
}
number ,
categoryIds:
{
Description: Array of product categories, https://docs.microsoft.com/en-us/azure/marketplace/marketplace-categories-industries#categories. Such as 'Productivity' ,
Required: False ,
}
[
string ,
]
,
industryIds:
{
Description: List of industry IDs the item belongs to ,
Required: False ,
}
[
string ,
]
,
publisherId:
{
Description: Publisher id ,
Required: False ,
}
string ,
azureBenefit:
{
Description: Eligibility for Azure consumption commitment benefit (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Possible values: - `Eligible` - Product is eligible for Azure consumption commitment benefit - `NotEligible` - Product is not eligible for Azure consumption commitment benefit ,
Required: False ,
}
string ,
badges:
{
Description: The following product badges are available: preferredSolution, powerBICertified, AdditionalPurchaseRequirement ,
Required: False ,
}
[
string ,
]
,
publisherType:
{
Description: A value indicating whether this is a Microsoft or third party product. Possible values: - `Microsoft` - Product is published by Microsoft (1st party product) - `Third Party` - Product is published by Third Party Vendor ,
Required: False ,
}
string ,
publishingStage:
{
Description: Product publishing stage. Possible values: - `Preview` - Product is available to restricted audience - `Public` - Product is publicly available in the Marketplace ,
Required: False ,
}
string ,
uniqueProductId:
{
Description: Unique product identifier ,
Required: False ,
}
string ,
productType:
{
Description: The delivery method or deployment model. Possible values: - `SaaS` - The product is a Software solution purchased on pay-as-you-go basis from a cloud service provider - `VirtualMachine` - The product is Image service instances with usage-based pricing - `AzureApplication` - Products published as Solution Templates (ST) or Azure Managed Apps (AMA) plans that deploy Azure resources to the customer tenant - `DynamicsCE` - All Dynamics products except for DynamicsBC and DynamicsOps - `DynamicsBC` - Dynamics 365 business Central - `Container` - The product is delivered as Container - `DynamicsOps` - Dynamics 365 Operations Apps - `None` - Product type returned for Azure Services, Container Extensions and VM extensions - `IotEdgeModules` - Resource is delivered as IoT Edge Module - `ContainerApps` - Resource is delivered as Container App - `ConsultingServices` Consulting Services (available only in Azure Marketplace as listing offers) - `ManagedServices` - The product is delivered as Managed Service - `PowerBI` - Power BI products - `CosellOnly` - Products available in scope of Co-Sell program only - `PowerBIVisuals` - Power BI Visuals products - `Office365` - Office 365 products - `DevService` - Dev Service - `AADApps` - Azure Active Directory Applications - `VisualStudioExtension` - Visual Studio Extensions ,
Required: True ,
}
string ,
operatingSystems:
{
Description: Operating system info for this product ,
Required: False ,
}
[
string ,
]
,
pricingTypes:
{
Description: The list of the pricing types for which this offer is designated. Possible Values: - `Free` - Product has at least one plan that is free of charge. - `FreeTrial` - Product has at least one plan that is free trial. - `Byol` - Product has at least one plan that is bring your own license. - `Payg` - Product has at least one plan that is Pay as you go, usage based billing model. - `Ri` - Product has at least one plan that is Reserved Instance billing model. ,
Required: False ,
}
[
string ,
]
,
publisherDisplayName:
{
Description: Publisher display name ,
Required: False ,
}
string ,
longSummary:
{
Description: Product long summary ,
Required: False ,
}
string ,
summary:
{
Description: Product summary ,
Required: False ,
}
string ,
linkedAddInsTypes:
{
Description: Linked add-in types ,
Required: False ,
}
object ,
smallIconUri:
{
Description: URI to the small product icon ,
Required: False ,
}
string ,
description:
{
Description: The product description text ,
Required: False ,
}
string ,
ratingBuckets:
{
Description: Rating buckets, Above1, Above2, Above3, Above4 ,
Required: False ,
}
[
string ,
]
,
ratingAverage:
{
Description: Average rating for the offer ,
Format: double ,
Required: False ,
}
number ,
ratingCount:
{
Description: Total number of ratings for the offer ,
Format: int32 ,
Required: False ,
}
integer ,
startingPrice:
{
Description: Retail price of the product's cheapest plan ,
Required: False ,
}
string ,
plans:
{
Description: Plans available for the offer details ,
Required: False ,
}
[
{
planId:
{
Description: Plan id ,
Required: False ,
}
string ,
uniquePlanId:
{
Description: Unique plan Id which is prefixed by combining uniqueProductId and PlanId with no separator in between ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the plan ,
Required: False ,
}
string ,
vmArchitectureType:
{
Description: VM Architecture Type. Applicable to Virtual Machine products only. PossibleValues: - `Arm64` - The VM image architecture of the plan is Arm64 - `X64Gen1` - The VM image architecture of the plan is X64 Generation1 - `X64Gen2` - The VM image architecture of the plan is X64 Generation2 ,
Required: False ,
}
string ,
cspState:
{
Description: Value showing whether the plan is available for purchase through CSP channel. Possible values: - `OptIn` - Plan configured CSP program opt-in for any partner in the CSP Program - `Optout` - Plan configured CSP program opt-out - `SelectiveOptIn` - Plan configured CSP program opt-in for specific partners in the CSP program ISV selects ,
Required: False ,
}
string ,
metadata:
{
Description: Additional plan metadata ,
Required: False ,
}
string ,
altStackReference:
{
Description: Alternative stack reference ,
Required: False ,
}
string ,
stackType:
{
Description: Stack type : Classic, Gen1, Gen2 ,
Required: False ,
}
string ,
altArchitectureReference:
{
Description: The alternative architecture reference ,
Required: False ,
}
string ,
categoryIds:
{
Description: Plan CategoryIds ,
Required: False ,
}
[
string ,
]
,
hasProtectedArtifacts:
{
Description: Set to true if plan has artifacts that are to be hidden for non authenticated users ,
Required: False ,
}
boolean ,
pricingTypes:
{
Description: The list of the pricing types for which this plan is designated (Possible values are the same as at product level) ,
Required: False ,
}
[
string ,
]
,
vmSecuritytypes:
{
Description: VM security type. Applicable to Virtual Machine products only. Possible values: - Standard - Basic level of security for the virtual machine - Trusted - protects against persistent and advanced attacks on Gen2 virtual machines with configurable features like security boot and virtual Trusted Platform Module(vTPM) - Confidential - on top of Trusted Launch, Confidential virtual machines offer higher confidentiality and integrity guaranteed with hardware-based trusted execution environment ,
Required: False ,
}
[
string ,
]
,
summary:
{
Description: The plan summary text ,
Required: False ,
}
string ,
description:
{
Description: Plan description ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU id ,
Required: False ,
}
string ,
planType:
{
Description: Managed Application or Solution template plan type (applicable only to Azure Applications product). Possible values: - `SolutionTemplate` - Solution Template plan type (applicable to Azure Applications only) - `ManagedApplication` - Managed Application plan type (applicable to Azure Applications only) ,
Required: True ,
}
string ,
displayRank:
{
Description: The order the plan is displayed in the 'Plans' table (as configured by the publisher) ,
Required: False ,
}
string ,
isPrivate:
{
Description: Indication that the plan is accessible to restricted audience only ,
Required: False ,
}
boolean ,
id:
{
Description: The id ,
Required: False ,
}
string ,
availabilities:
{
Description: List of availabilities for this plan ,
Required: False ,
}
[
{
id:
{
Description: The document id ,
Required: False ,
}
string ,
actions:
{
Description: List of allowed actions ,
Required: False ,
}
[
string ,
]
,
meter:
{
Description: Applicable billing meter information ,
Required: False ,
}
string ,
pricingAudience:
{
Description: Supported pricing audiences. Possible values: - `DirectCommercial` - Available to commercial direct channel - `PartnerCommercial` - Available to Cloud Solution Providers (CSP) ,
Required: True ,
}
string ,
terms:
{
Description: List of applicable terms ,
Required: False ,
}
[
{
termDescriptionParameters:
{
Description: Term description parameters ,
Required: False ,
}
[
{
parameter:
{
Description: Parameter ,
Required: False ,
}
string ,
value:
{
Description: Value ,
Required: False ,
}
string ,
}
,
]
,
termId:
{
Description: Term id ,
Required: False ,
}
string ,
termUnit:
{
Description: Term unit ,
Required: False ,
}
string ,
prorationPolicy:
{
Description: Proration policy ,
Required: False ,
}
string ,
termDescription:
{
Description: Term description ,
Required: False ,
}
string ,
price:
{
Description: Price for the term ,
Required: False ,
}
string ,
renewTermId:
{
Description: Renew term id ,
Required: False ,
}
string ,
renewTermUnits:
{
Description: Renew term units ,
Required: False ,
}
string ,
billingPlan:
{
Description: Billing Plan ,
Required: False ,
}
string ,
renewToTermBillingPlan:
{
Description: Renew Billing Plan ,
Required: False ,
}
string ,
isAutorenewable:
{
Description: Indicates if autorenew is enabled ,
Required: False ,
}
boolean ,
}
,
]
,
hasFreeTrials:
{
Description: A value indicating whether it has free trials ,
Required: True ,
}
boolean ,
consumptionUnitType:
{
Description: Consumption unit type ,
Required: False ,
}
string ,
displayRank:
{
Description: Display rank ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
uiDefinitionUri:
{
Description: What blade to open when someone wants to create a marketplace item ,
Required: False ,
}
string ,
artifacts:
{
Description: Files related to the marketplace item ,
Required: False ,
}
[
{
name:
{
Description: Artifact name ,
Required: False ,
}
string ,
uri:
{
Description: Artifact uri ,
Required: False ,
}
string ,
artifactType:
{
Description: The type of the artifact. Possible values: - `Custom` - Custom artifact type - `Fragment` - Contains link to the nested ARM template - `Metadata` - Metadata artifact type - `Template` - Contains link to the main ARM template ,
Required: True ,
}
string ,
}
,
]
,
version:
{
Description: Version of the marketplace item ,
Required: False ,
}
string ,
isHidden:
{
Description: A value indicating whether the plan is hidden ,
Required: True ,
}
boolean ,
isStopSell:
{
Description: A value indicating whether plan has been stopped from selling ,
Required: True ,
}
boolean ,
stopSellInfo:
{
Description: A StopSellInfo object providing stop sell related data ,
Required: False ,
}
string ,
minQuantity:
{
Description: Min quantity ,
Format: int32 ,
Required: False ,
}
integer ,
maxQuantity:
{
Description: Max quantity ,
Format: int32 ,
Required: False ,
}
integer ,
isQuantifiable:
{
Description: A value indicating whether the plan is quantifiable ,
Required: True ,
}
boolean ,
billingComponents:
{
Description: Billing components ,
Required: False ,
}
[
{
billingTag:
{
Description: Billing Tag ,
Required: False ,
}
string ,
customMeterIds:
{
Description: Custom Meter Ids ,
Required: False ,
}
object ,
}
,
]
,
purchaseDurationDiscounts:
{
Description: List of purchase duration discounts ,
Required: False ,
}
[
{
duration:
{
Description: The duration ,
Required: False ,
}
string ,
discountPercentage:
{
Description: The discount percentage ,
Required: True ,
}
number ,
}
,
]
,
isHiddenPrivateOffer:
{
Description: A value indicating whether the plan is used as hidden private offer requiring a quote ,
Required: False ,
}
boolean ,
certifications:
{
Description: List of certifications ,
Required: False ,
}
[
{
id:
{
Description: Id of the link ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the link ,
Required: False ,
}
string ,
uri:
{
Description: URI of the link ,
Required: False ,
}
string ,
}
,
]
,
customerInstruction:
{
Description: Plan's customer instruction for purchasing ,
Required: False ,
}
string ,
}
,
]
,
supportedProducts:
{
Description: Maps to the list of compatible products that the publisher provides ,
Required: False ,
}
[
string ,
]
,
applicableProducts:
{
Description: Product categories the offer belongs to ,
Required: False ,
}
[
string ,
]
,
lastModifiedDateTime:
{
Description: Latest update date of the product ,
Format: date-time ,
Required: False ,
}
string ,
language:
{
Description: The product language ,
Required: False ,
}
string ,
hasStandardContractAmendments:
{
Description: A value indicating whether standard contract amendments are present for this product ,
Required: True ,
}
boolean ,
offerId:
{
Description: The offer id ,
Required: False ,
}
string ,
standardContractAmendmentsRevisionId:
{
Description: Standard contract amendments for the product ,
Required: True ,
}
string ,
universalAmendmentUrl:
{
Description: The universal amendment link for an enterprise contract. ,
Required: False ,
}
string ,
isPrivate:
{
Description: A value indicating whether the item is private ,
Required: True ,
}
boolean ,
isStopSell:
{
Description: A value indicating whether sale of this item is stopped ,
Required: True ,
}
boolean ,
stopSellInfo:
{
Description: A StopSellInfo object providing stop sell related data ,
Required: False ,
}
string ,
marketingMaterial:
{
Description: Marketing material added by the publisher ,
Required: False ,
}
string ,
legalTermsUri:
{
Description: Legal terms URI ,
Required: False ,
}
string ,
cspLegalTermsUri:
{
Description: CSP legal terms URI ,
Required: False ,
}
string ,
legalTermsType:
{
Description: Supported legal terms type. Possible values: - `EA` - Microsoft Enterprise Agreement - `None` - None ,
Required: True ,
}
string ,
privacyPolicyUri:
{
Description: Uri to the privacy policy of the product ,
Required: False ,
}
string ,
supportUri:
{
Description: Support uri of the product ,
Required: False ,
}
string ,
uiDefinitionUri:
{
Description: User interface definition uri ,
Required: False ,
}
string ,
screenshotUris:
{
Description: List of screenshot image URIs provided for the item ,
Required: False ,
}
[
string ,
]
,
links:
{
Description: List of Links provided for the item ,
Required: False ,
}
[
{
id:
{
Description: Id of the link ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the link ,
Required: False ,
}
string ,
uri:
{
Description: URI of the link ,
Required: False ,
}
string ,
}
,
]
,
linkedAddIns:
{
Description: List of linked Add Ins provided for the item ,
Required: False ,
}
[
string ,
]
,
mediumIconUri:
{
Description: URI to the medium product icon ,
Required: False ,
}
string ,
largeIconUri:
{
Description: URI to the large product icon ,
Required: False ,
}
string ,
wideIconUri:
{
Description: URI to the wide product icon ,
Required: False ,
}
string ,
images:
{
Description: List of Images ,
Required: False ,
}
[
{
context:
{
Description: context ,
Required: False ,
}
string ,
items:
{
Description: List of images ,
Required: False ,
}
[
{
id:
{
Description: Image id ,
Required: False ,
}
string ,
uri:
{
Description: Image uri ,
Required: False ,
}
string ,
type:
{
Description: Image type ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
artifacts:
{
Description: List of artifacts ,
Required: False ,
}
[
{
name:
{
Description: Artifact name ,
Required: False ,
}
string ,
uri:
{
Description: Artifact uri ,
Required: False ,
}
string ,
artifactType:
{
Description: The type of the artifact. Possible values: - `Custom` - Custom artifact type - `Fragment` - Contains link to the nested ARM template - `Metadata` - Metadata artifact type - `Template` - Contains link to the main ARM template ,
Required: True ,
}
string ,
}
,
]
,
videos:
{
Description: List of product videos ,
Required: False ,
}
[
{
caption:
{
Description: Caption ,
Required: False ,
}
string ,
uri:
{
Description: Video uri ,
Format: uri ,
Required: False ,
}
string ,
videoPurpose:
{
Description: Video purpose ,
Required: False ,
}
string ,
previewImage:
{
Description: Preview image ,
Required: False ,
}
string ,
}
,
]
,
additionalProductProperties:
{
Description: Dictionary of additional properties provided for the item ,
Required: False ,
}
object ,
pricingDetailsUri:
{
Description: Pricing details uri of the product ,
Required: False ,
}
string ,
isReseller:
{
Description: A value indicating whether microsoft is acting as a reseller ,
Required: True ,
}
boolean ,
productOwnershipSellingMotion:
{
Description: Product ownership selling motion ,
Required: False ,
}
string ,
disableSendEmailOnPurchase:
{
Description: Indication to disable sending email on purchase ,
Required: True ,
}
boolean ,
isCoreVm:
{
Description: Set to true only for offers of ProductType.VirtualMachine to indicate that it was originally of ProductType.CoreVirtualMachine ,
Required: False ,
}
boolean ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code ,
}
string ,
}
,
$schema:
{
Description: The Catalog API error response object ,
}
{
error:
{
Description: The Catalog API response details ,
Required: True ,
}
{
code:
{
Description: The error code description. Such as code=InternalError ,
Required: True ,
}
string ,
message:
{
Description: The error message. Such as message=Internal server error ,
Required: True ,
}
string ,
}
,
}
,
}
PublicProducts_List (updated)
Description :  Get a list of commercial public products.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PublicProducts_List",
  "Summary": {
    "new": "Get a list of commercial public products.",
    "old": "Public Products API provides an unauthenticated endpoint for consuming commercial Marketplace public products. In addition, it enables filtering on selected product\u202fproperties, search, and getting starting price information per product. Each API request must include an API key allocated to you (see X-API-Key description).Send an email to MKPL_Platform_API_DL@microsoft.com including the following details to get the API Key:\n- Customer name\n- Service/Product name\n- AD Registered App ID (if available)\n- Focal point email\n- Use case/scenario\n- Expected traffic volume, including peak requests per second (daily)"
  }
}

⚼ Request

GET:  /products
{
api-version:
{
Description: Version of the REST API used for the request. ,
Required: True ,
}
string ,
storefront:
{
Description: Relevant storefront, possible values - 'azure, amp, appsource'. Default='azure' ,
Required: False ,
}
string ,
language:
{
Description: Language to search, ISO 639-1 two-letter code, possible values - 'en,cs,de,es,fr,hu,it,ja,ko,nl,pl,pt-br,pt-pt,ru,sv,tr,zh-hans,zh-hant'. Default is "en" ,
Required: False ,
}
string ,
market:
{
Description: Product market value (the response will include only products that can be sold in the specified market) Possible values can be found at https://docs.microsoft.com/en-us/azure/marketplace/marketplace-geo-availability-currencies. Example: 'US' ,
Required: False ,
}
string ,
hideKeys:
{
Description: Add hide key to retrieve preview items. Hidekeys are provided in 'multi' format. Example: HideKey[]=first ,
Required: False ,
}
array ,
select:
{
Description: Selects which properties to include in the results. Example: 'select=displayName' ,
Required: False ,
}
array ,
filter:
{
Description: Filters the results, based on a Boolean condition. Example: 'filter=productType eq "VirtualMachine"'. Fields that can be filtered by are: - `displayName` - `popularity` - `categoryIds` - `industryIds` - `publisherId` - `uniqueProductId` - `productType` - `operatingSystems` - `pricingTypes` - `publisherDisplayName` - `longSummary` - `summary` - `linkedAddinsTypes` - `description` - `supportedProducts` - `applicableProducts` - `lastModifiedDateTime` - `plan.planId` - `plan.displayName` - `plan.cspState` - `plan.altStackReference` - `plan.stackType` - `plan.categoryIds` - `plan.hasProtectedArtifacts` - `plan.pricingTypes` - `plan.summary` - `plan.description` - `plan.skuId` - `plan.displayRank` - `plan.isPrivate` ,
Required: False ,
}
string ,
expand:
{
Description: Expands related entities inline. Example: 'expand=startingPrice' ,
Required: False ,
}
array ,
orderby:
{
Description: Ordering expression for the results using OData notation. Avoid using orderby unless essential as this may impact the latency of your request. Example: 'orderby=displayName desc'.This API only supports ordering by a single field. Fields that can be ordered by are: - `lastModifiedDateTime` - `uniqueProductId` - `productType` - `displayName` - `publisherId` ,
Required: False ,
}
string ,
X-API-Key:
{
Description: Use Api key provided by Marketplace Catalog Team as a parameter provided in the header ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
items:
{
Description: The list of returned items ,
Required: False ,
}
[
{
displayName:
{
Description: Product display name ,
Required: False ,
}
string ,
popularity:
{
Description: Popularity of the product ,
Format: double ,
Required: False ,
}
number ,
categoryIds:
{
Description: Array of product categories, https://docs.microsoft.com/en-us/azure/marketplace/marketplace-categories-industries#categories. Such as 'Productivity' ,
Required: False ,
}
[
string ,
]
,
industryIds:
{
Description: List of industry IDs the item belongs to ,
Required: False ,
}
[
string ,
]
,
publisherId:
{
Description: Publisher id ,
Required: False ,
}
string ,
azureBenefit:
{
Description: Eligibility for Azure consumption commitment benefit (https://docs.microsoft.com/en-us/marketplace/azure-consumption-commitment-benefit). Possible values: - `Eligible` - Product is eligible for Azure consumption commitment benefit - `NotEligible` - Product is not eligible for Azure consumption commitment benefit ,
Required: False ,
}
string ,
badges:
{
Description: The following product badges are available: preferredSolution, powerBICertified, AdditionalPurchaseRequirement ,
Required: False ,
}
[
string ,
]
,
publisherType:
{
Description: A value indicating whether this is a Microsoft or third party product. Possible values: - `Microsoft` - Product is published by Microsoft (1st party product) - `Third Party` - Product is published by Third Party Vendor ,
Required: False ,
}
string ,
publishingStage:
{
Description: Product publishing stage. Possible values: - `Preview` - Product is available to restricted audience - `Public` - Product is publicly available in the Marketplace ,
Required: False ,
}
string ,
uniqueProductId:
{
Description: Unique product identifier ,
Required: False ,
}
string ,
productType:
{
Description: The delivery method or deployment model. Possible values: - `SaaS` - The product is a Software solution purchased on pay-as-you-go basis from a cloud service provider - `VirtualMachine` - The product is Image service instances with usage-based pricing - `AzureApplication` - Products published as Solution Templates (ST) or Azure Managed Apps (AMA) plans that deploy Azure resources to the customer tenant - `DynamicsCE` - All Dynamics products except for DynamicsBC and DynamicsOps - `DynamicsBC` - Dynamics 365 business Central - `Container` - The product is delivered as Container - `DynamicsOps` - Dynamics 365 Operations Apps - `None` - Product type returned for Azure Services, Container Extensions and VM extensions - `IotEdgeModules` - Resource is delivered as IoT Edge Module - `ContainerApps` - Resource is delivered as Container App - `ConsultingServices` - Consulting Services (available only in Azure Marketplace as listing offers) - `ManagedServices` - The product is delivered as Managed Service - `PowerBI` - Power BI products - `CosellOnly` - Products available in scope of Co-Sell program only - `PowerBIVisuals` - Power BI Visuals products - `Office365` - Office 365 products - `DevService` - Dev Service - `AADApps` - Azure Active Directory Applications - `VisualStudioExtension` - Visual Studio Extensions ,
Required: True ,
}
string ,
operatingSystems:
{
Description: Operating system info for this product ,
Required: False ,
}
[
string ,
]
,
pricingTypes:
{
Description: The list of the pricing types for which this offer is designated. Possible Values: - `Free` - Product has at least one plan that is free of charge. - `FreeTrial` - Product has at least one plan that is free trial. - `Byol` - Product has at least one plan that is bring your own license. - `Payg` - Product has at least one plan that is Pay as you go, usage based billing model. - `Ri` - Product has at least one plan that is Reserved Instance billing model. ,
Required: False ,
}
[
string ,
]
,
publisherDisplayName:
{
Description: Publisher display name ,
Required: False ,
}
string ,
longSummary:
{
Description: Product long summary ,
Required: False ,
}
string ,
summary:
{
Description: Product summary ,
Required: False ,
}
string ,
linkedAddInsTypes:
{
Description: Linked add-in types ,
Required: False ,
}
object ,
smallIconUri:
{
Description: URI to the small product icon ,
Required: False ,
}
string ,
description:
{
Description: The product description text ,
Required: False ,
}
string ,
ratingBuckets:
{
Description: Rating buckets, Above1, Above2, Above3, Above4 ,
Required: False ,
}
[
string ,
]
,
ratingAverage:
{
Description: Average rating for the offer ,
Format: double ,
Required: False ,
}
number ,
ratingCount:
{
Description: Total number of ratings for the offer ,
Format: int32 ,
Required: False ,
}
integer ,
startingPrice:
{
Description: Retail price of the product's cheapest plan ,
Required: False ,
}
string ,
plans:
{
Description: List of plans that are available for this product ,
Required: False ,
}
[
{
planId:
{
Description: Plan id ,
Required: False ,
}
string ,
uniquePlanId:
{
Description: Unique plan Id which is prefixed by combining uniqueProductId and PlanId with no separator in between ,
Required: False ,
}
string ,
displayName:
{
Description: Display name of the plan ,
Required: False ,
}
string ,
vmArchitectureType:
{
Description: VM Architecture Type. Applicable to Virtual Machine products only. PossibleValues: - `Arm64` - The VM image architecture of the plan is Arm64 - `X64Gen1` - The VM image architecture of the plan is X64 Generation1 - `X64Gen2` - The VM image architecture of the plan is X64 Generation2 ,
Required: False ,
}
string ,
cspState:
{
Description: A value indicating whether the product is available for purchase through CSP channel ,
Required: False ,
}
string ,
metadata:
{
Description: Additional plan metadata ,
Required: False ,
}
string ,
altStackReference:
{
Description: Alternative stack reference ,
Required: False ,
}
string ,
stackType:
{
Description: Stack type : Classic, Gen1, Gen2 ,
Required: False ,
}
string ,
altArchitectureReference:
{
Description: The alternative architecture reference ,
Required: False ,
}
string ,
categoryIds:
{
Description: Plan CategoryIds ,
Required: False ,
}
[
string ,
]
,
hasProtectedArtifacts:
{
Description: Set to true if plan has artifacts that are to be hidden for non authenticated users ,
Required: False ,
}
boolean ,
pricingTypes:
{
Description: The list of the pricing types for which this plan is designated (Possible values are the same as at product level) ,
Required: False ,
}
[
string ,
]
,
vmSecuritytypes:
{
Description: VM security type. Applicable to Virtual Machine products only. Possible values: - Standard - Basic level of security for the virtual machine - Trusted - protects against persistent and advanced attacks on Gen2 virtual machines with configurable features like security boot and virtual Trusted Platform Module(vTPM) - Confidential - on top of Trusted Launch, Confidential virtual machines offer higher confidentiality and integrity guaranteed with hardware-based trusted execution environment ,
Required: False ,
}
[
string ,
]
,
summary:
{
Description: The plan summary text ,
Required: False ,
}
string ,
description:
{
Description: Plan description ,
Required: False ,
}
string ,
skuId:
{
Description: The SKU id ,
Required: False ,
}
string ,
planType:
{
Description: Managed Application or Solution template plan type (applicable only to Azure Applications product). Possible values: - `SolutionTemplate` - Solution Template plan type (applicable to Azure Applications only) - `ManagedApplication` - Managed Application plan type (applicable to Azure Applications only) ,
Required: True ,
}
string ,
displayRank:
{
Description: The order the plan is displayed in the 'Plans' table (as configured by the publisher) ,
Required: False ,
}
string ,
isPrivate:
{
Description: Indication that the plan is accessible to restricted audience only ,
Required: False ,
}
boolean ,
}
,
]
,
supportedProducts:
{
Description: Maps to the list of compatible products that the publisher provides ,
Required: False ,
}
[
string ,
]
,
applicableProducts:
{
Description: Product categories the offer belongs to ,
Required: False ,
}
[
string ,
]
,
lastModifiedDateTime:
{
Description: Latest update date of the product ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
nextPageLink:
{
Description: Link to the next page where request returns more than a single page of results ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: Error code ,
}
string ,
}
,
$schema:
{
Description: The Catalog API error response object ,
}
{
error:
{
Description: The Catalog API response details ,
Required: True ,
}
{
code:
{
Description: The error code description. Such as code=InternalError ,
Required: True ,
}
string ,
message:
{
Description: The error message. Such as message=Internal server error ,
Required: True ,
}
string ,
}
,
}
,
}